<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>textrender: GStreamer Base Plugins 1.0 Plugins Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GStreamer Base Plugins 1.0 Plugins Reference Manual">
<link rel="up" href="ch01.html" title="gst-plugins-base Elements">
<link rel="prev" href="gst-plugins-base-plugins-textoverlay.html" title="textoverlay">
<link rel="next" href="gst-plugins-base-plugins-theoradec.html" title="theoradec">
<meta name="generator" content="GTK-Doc V1.28 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#gst-plugins-base-plugins-textrender.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#gst-plugins-base-plugins-textrender.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#gst-plugins-base-plugins-textrender.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="gst-plugins-base-plugins-textoverlay.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gst-plugins-base-plugins-theoradec.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gst-plugins-base-plugins-textrender"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gst-plugins-base-plugins-textrender.top_of_page"></a>textrender</span></h2>
<p>textrender</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="gst-plugins-base-plugins-textrender.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRender--font-desc" title="The “font-desc” property">font-desc</a></td>
<td class="property_flags">Write</td>
</tr>
<tr>
<td class="property_type"><a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRenderHAlign" title="enum GstTextRenderHAlign"><span class="type">GstTextRenderHAlign</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRender--halignment" title="The “halignment” property">halignment</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRenderLineAlign" title="enum GstTextRenderLineAlign"><span class="type">GstTextRenderLineAlign</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRender--line-alignment" title="The “line-alignment” property">line-alignment</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRenderVAlign" title="enum GstTextRenderVAlign"><span class="type">GstTextRenderVAlign</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRender--valignment" title="The “valignment” property">valignment</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRender--xpad" title="The “xpad” property">xpad</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRender--ypad" title="The “ypad” property">ypad</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<a name="GstTextRender"></a><div class="refsect1">
<a name="gst-plugins-base-plugins-textrender.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRender-struct" title="struct GstTextRender">GstTextRender</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRenderHAlign" title="enum GstTextRenderHAlign">GstTextRenderHAlign</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRenderLineAlign" title="enum GstTextRenderLineAlign">GstTextRenderLineAlign</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRenderVAlign" title="enum GstTextRenderVAlign">GstTextRenderVAlign</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gst-plugins-base-plugins-textrender.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
    <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
        <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a>
            <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a>
                <span class="lineart">╰──</span> GstTextRender
</pre>
</div>
<div class="refsect1">
<a name="gst-plugins-base-plugins-textrender.description"></a><h2>Description</h2>
<p>This plugin renders text received on the text sink pad to a video
buffer (retaining the alpha channel), so it can later be overlayed
on top of video streams using other elements.</p>
<p>The text can contain newline characters. (FIXME: What about text
wrapping? It does not make sense in this context)</p>
<div class="refsect3">
<a name="id-1.2.98.7.4"></a><h4>Example launch lines</h4>
<div class="informalexample">
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
    <tbody>
      <tr>
        <td class="listing_lines" align="right"><pre>1</pre></td>
        <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch<span class="gtkdoc opt">-</span><span class="number">1.0</span> <span class="gtkdoc opt">-</span>v filesrc location<span class="gtkdoc opt">=</span>subtitles<span class="gtkdoc opt">.</span>srt <span class="gtkdoc opt">!</span> subparse <span class="gtkdoc opt">!</span> textrender <span class="gtkdoc opt">!</span> videoconvert <span class="gtkdoc opt">!</span> autovideosink</pre></td>
      </tr>
    </tbody>
  </table>
</div>

<p></p>
</div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<div class="refsect2">
<a name="id-1.2.98.7.5.1"></a><h3>Element Information</h3>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">plugin</span></p></td>
<td>
            <a class="link" href="gst-plugins-base-plugins-plugin-pango.html#plugin-pango">pango</a>
          </td>
</tr>
<tr>
<td><p><span class="term">author</span></p></td>
<td>David Schleef &lt;ds@schleef.org&gt;, GStreamer maintainers &lt;gstreamer-devel@lists.freedesktop.org&gt;</td>
</tr>
<tr>
<td><p><span class="term">class</span></p></td>
<td>Filter/Editor/Video</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="id-1.2.98.7.5.2"></a><h3>Element Pads</h3>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">name</span></p></td>
<td>sink</td>
</tr>
<tr>
<td><p><span class="term">direction</span></p></td>
<td>sink</td>
</tr>
<tr>
<td><p><span class="term">presence</span></p></td>
<td>always</td>
</tr>
<tr>
<td><p><span class="term">details</span></p></td>
<td>text/x-raw, format=(string){ pango-markup, utf8 }</td>
</tr>
</tbody>
</table></div>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">name</span></p></td>
<td>src</td>
</tr>
<tr>
<td><p><span class="term">direction</span></p></td>
<td>source</td>
</tr>
<tr>
<td><p><span class="term">presence</span></p></td>
<td>always</td>
</tr>
<tr>
<td><p><span class="term">details</span></p></td>
<td>video/x-raw, format=(string){ AYUV, ARGB }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-base-plugins-textrender.functions_details"></a><h2>Functions</h2>
<p></p>
</div>
<div class="refsect1">
<a name="gst-plugins-base-plugins-textrender.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GstTextRender-struct"></a><h3>struct GstTextRender</h3>
<pre class="programlisting">struct GstTextRender;</pre>
<p>Opaque textrender data structure.</p>
</div>
<hr>
<div class="refsect2">
<a name="GstTextRenderHAlign"></a><h3>enum GstTextRenderHAlign</h3>
<p>Horizontal alignment of the text.</p>
<div class="refsect3">
<a name="GstTextRenderHAlign.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="GST-TEXT-RENDER-HALIGN-LEFT:CAPS"></a>GST_TEXT_RENDER_HALIGN_LEFT</p></td>
<td class="enum_member_description">
<p>align text left</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GST-TEXT-RENDER-HALIGN-CENTER:CAPS"></a>GST_TEXT_RENDER_HALIGN_CENTER</p></td>
<td class="enum_member_description">
<p>align text center</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GST-TEXT-RENDER-HALIGN-RIGHT:CAPS"></a>GST_TEXT_RENDER_HALIGN_RIGHT</p></td>
<td class="enum_member_description">
<p>align text right</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="GstTextRenderLineAlign"></a><h3>enum GstTextRenderLineAlign</h3>
<p>Alignment of text lines relative to each other</p>
<div class="refsect3">
<a name="GstTextRenderLineAlign.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="GST-TEXT-RENDER-LINE-ALIGN-LEFT:CAPS"></a>GST_TEXT_RENDER_LINE_ALIGN_LEFT</p></td>
<td class="enum_member_description">
<p>lines are left-aligned</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GST-TEXT-RENDER-LINE-ALIGN-CENTER:CAPS"></a>GST_TEXT_RENDER_LINE_ALIGN_CENTER</p></td>
<td class="enum_member_description">
<p>lines are center-aligned</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GST-TEXT-RENDER-LINE-ALIGN-RIGHT:CAPS"></a>GST_TEXT_RENDER_LINE_ALIGN_RIGHT</p></td>
<td class="enum_member_description">
<p>lines are right-aligned</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="GstTextRenderVAlign"></a><h3>enum GstTextRenderVAlign</h3>
<p>Vertical alignment of the text.</p>
<div class="refsect3">
<a name="GstTextRenderVAlign.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="GST-TEXT-RENDER-VALIGN-BASELINE:CAPS"></a>GST_TEXT_RENDER_VALIGN_BASELINE</p></td>
<td class="enum_member_description">
<p>draw text on the baseline</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GST-TEXT-RENDER-VALIGN-BOTTOM:CAPS"></a>GST_TEXT_RENDER_VALIGN_BOTTOM</p></td>
<td class="enum_member_description">
<p>draw text on the bottom</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GST-TEXT-RENDER-VALIGN-TOP:CAPS"></a>GST_TEXT_RENDER_VALIGN_TOP</p></td>
<td class="enum_member_description">
<p>draw test on top</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-base-plugins-textrender.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GstTextRender--font-desc"></a><h3>The <code class="literal">“font-desc”</code> property</h3>
<pre class="programlisting">  “font-desc”                <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>Pango font description of font to be used for rendering. See documentation of pango_font_description_from_string for syntax.</p>
<p>Flags: Write</p>
<p>Default value: ""</p>
</div>
<hr>
<div class="refsect2">
<a name="GstTextRender--halignment"></a><h3>The <code class="literal">“halignment”</code> property</h3>
<pre class="programlisting">  “halignment”               <a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRenderHAlign" title="enum GstTextRenderHAlign"><span class="type">GstTextRenderHAlign</span></a></pre>
<p>Horizontal alignment of the text.</p>
<p>Flags: Read / Write</p>
<p>Default value: center</p>
</div>
<hr>
<div class="refsect2">
<a name="GstTextRender--line-alignment"></a><h3>The <code class="literal">“line-alignment”</code> property</h3>
<pre class="programlisting">  “line-alignment”           <a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRenderLineAlign" title="enum GstTextRenderLineAlign"><span class="type">GstTextRenderLineAlign</span></a></pre>
<p>Alignment of text lines relative to each other.</p>
<p>Flags: Read / Write</p>
<p>Default value: center</p>
</div>
<hr>
<div class="refsect2">
<a name="GstTextRender--valignment"></a><h3>The <code class="literal">“valignment”</code> property</h3>
<pre class="programlisting">  “valignment”               <a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRenderVAlign" title="enum GstTextRenderVAlign"><span class="type">GstTextRenderVAlign</span></a></pre>
<p>Vertical alignment of the text.</p>
<p>Flags: Read / Write</p>
<p>Default value: baseline</p>
</div>
<hr>
<div class="refsect2">
<a name="GstTextRender--xpad"></a><h3>The <code class="literal">“xpad”</code> property</h3>
<pre class="programlisting">  “xpad”                     <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
<p>Horizontal paddding when using left/right alignment.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: &gt;= 0</p>
<p>Default value: 25</p>
</div>
<hr>
<div class="refsect2">
<a name="GstTextRender--ypad"></a><h3>The <code class="literal">“ypad”</code> property</h3>
<pre class="programlisting">  “ypad”                     <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
<p>Vertical padding when using top/bottom alignment.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: &gt;= 0</p>
<p>Default value: 25</p>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-base-plugins-textrender.see-also"></a><h2>See Also</h2>
<p><a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay"><span class="type">GstTextOverlay</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.28</div>
</body>
</html>